<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.analyzer.model;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.Serializable;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.ArrayList;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Collections;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.Comparator;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.List;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.TreeMap;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    import org.hackystat.utilities.time.period.TimePeriod;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    /**<a name="line.12"></a>
<FONT color="green">013</FONT>     * Represents a single telemetry stream, which contains an ordered series of TelemetryDataPoint<a name="line.13"></a>
<FONT color="green">014</FONT>     * instances.<a name="line.14"></a>
<FONT color="green">015</FONT>     * <a name="line.15"></a>
<FONT color="green">016</FONT>     * @author (Cedric) Qin Zhang<a name="line.16"></a>
<FONT color="green">017</FONT>     */<a name="line.17"></a>
<FONT color="green">018</FONT>    public class TelemetryStream {<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>      private static final TelemetryDataPointTimePeriodComparator DATAPOINT_TIMEPERIOD_COMPARATOR <a name="line.20"></a>
<FONT color="green">021</FONT>          = new TelemetryDataPointTimePeriodComparator();<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>      private Object tag;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>      private TreeMap&lt;TimePeriod, TelemetryDataPoint&gt; dataPoints = <a name="line.25"></a>
<FONT color="green">026</FONT>        new TreeMap&lt;TimePeriod, TelemetryDataPoint&gt;();<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>      /**<a name="line.28"></a>
<FONT color="green">029</FONT>       * Constructs this instance.<a name="line.29"></a>
<FONT color="green">030</FONT>       * <a name="line.30"></a>
<FONT color="green">031</FONT>       * @param tag An object that helps to recognize this telemetry stream. Null is<a name="line.31"></a>
<FONT color="green">032</FONT>       *        a valid value.<a name="line.32"></a>
<FONT color="green">033</FONT>       */<a name="line.33"></a>
<FONT color="green">034</FONT>      public TelemetryStream(Object tag) {<a name="line.34"></a>
<FONT color="green">035</FONT>        this.tag = tag;<a name="line.35"></a>
<FONT color="green">036</FONT>      }<a name="line.36"></a>
<FONT color="green">037</FONT>    <a name="line.37"></a>
<FONT color="green">038</FONT>      /**<a name="line.38"></a>
<FONT color="green">039</FONT>       * Gets the tag associated with this telemetry stream.<a name="line.39"></a>
<FONT color="green">040</FONT>       * <a name="line.40"></a>
<FONT color="green">041</FONT>       * @return The tag object.<a name="line.41"></a>
<FONT color="green">042</FONT>       */<a name="line.42"></a>
<FONT color="green">043</FONT>      public Object getTag() {<a name="line.43"></a>
<FONT color="green">044</FONT>        return this.tag;<a name="line.44"></a>
<FONT color="green">045</FONT>      }<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>      /**<a name="line.47"></a>
<FONT color="green">048</FONT>       * Sets the tag associated with this telemetry stream.<a name="line.48"></a>
<FONT color="green">049</FONT>       * <a name="line.49"></a>
<FONT color="green">050</FONT>       * @param tag The new tag value<a name="line.50"></a>
<FONT color="green">051</FONT>       */<a name="line.51"></a>
<FONT color="green">052</FONT>      public void setTag(final Object tag) {<a name="line.52"></a>
<FONT color="green">053</FONT>        this.tag = tag;<a name="line.53"></a>
<FONT color="green">054</FONT>      }<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>      /**<a name="line.56"></a>
<FONT color="green">057</FONT>       * Adds a data point to this telemetry stream. Note that the time period in<a name="line.57"></a>
<FONT color="green">058</FONT>       * all data points must be of the same type (either day, week, or month).<a name="line.58"></a>
<FONT color="green">059</FONT>       * Otherwise, an exception will be raised.<a name="line.59"></a>
<FONT color="green">060</FONT>       * <a name="line.60"></a>
<FONT color="green">061</FONT>       * @param dataPoint The data point to be added.<a name="line.61"></a>
<FONT color="green">062</FONT>       * <a name="line.62"></a>
<FONT color="green">063</FONT>       * @throws TelemetryDataModelException If the data for the time period already exists.<a name="line.63"></a>
<FONT color="green">064</FONT>       */<a name="line.64"></a>
<FONT color="green">065</FONT>      public void addDataPoint(TelemetryDataPoint dataPoint) throws TelemetryDataModelException {<a name="line.65"></a>
<FONT color="green">066</FONT>        try {<a name="line.66"></a>
<FONT color="green">067</FONT>          TimePeriod period = dataPoint.getPeriod();<a name="line.67"></a>
<FONT color="green">068</FONT>          if (this.dataPoints.containsKey(period)) {<a name="line.68"></a>
<FONT color="green">069</FONT>            throw new TelemetryDataModelException("Duplicated period: " + period.toString());<a name="line.69"></a>
<FONT color="green">070</FONT>          }<a name="line.70"></a>
<FONT color="green">071</FONT>          this.dataPoints.put(period, dataPoint);<a name="line.71"></a>
<FONT color="green">072</FONT>        }<a name="line.72"></a>
<FONT color="green">073</FONT>        catch (ClassCastException ex) {<a name="line.73"></a>
<FONT color="green">074</FONT>          // this exception is raised when the types of time period in data points are different.<a name="line.74"></a>
<FONT color="green">075</FONT>          throw new <a name="line.75"></a>
<FONT color="green">076</FONT>          TelemetryDataModelException("All data points must have the same time period type.", ex);<a name="line.76"></a>
<FONT color="green">077</FONT>        }<a name="line.77"></a>
<FONT color="green">078</FONT>      }<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>      /**<a name="line.80"></a>
<FONT color="green">081</FONT>       * Gets the value associated with the specified time period. Note that if this<a name="line.81"></a>
<FONT color="green">082</FONT>       * telemetry stream does not contain the data point associated the time<a name="line.82"></a>
<FONT color="green">083</FONT>       * period, an exception is raised. If a null is return, it means that this<a name="line.83"></a>
<FONT color="green">084</FONT>       * streams contains the data point, but the value in that data point is null.<a name="line.84"></a>
<FONT color="green">085</FONT>       * <a name="line.85"></a>
<FONT color="green">086</FONT>       * @param timePeriod The time period.<a name="line.86"></a>
<FONT color="green">087</FONT>       * @return The value.<a name="line.87"></a>
<FONT color="green">088</FONT>       * <a name="line.88"></a>
<FONT color="green">089</FONT>       * @throws TelemetryDataModelException If there is no value associated with the<a name="line.89"></a>
<FONT color="green">090</FONT>       *         time period.<a name="line.90"></a>
<FONT color="green">091</FONT>       */<a name="line.91"></a>
<FONT color="green">092</FONT>      public Number getDataPointValue(TimePeriod timePeriod) throws TelemetryDataModelException {<a name="line.92"></a>
<FONT color="green">093</FONT>        TelemetryDataPoint dataPoint = this.dataPoints.get(timePeriod);<a name="line.93"></a>
<FONT color="green">094</FONT>        if (dataPoint == null) {<a name="line.94"></a>
<FONT color="green">095</FONT>          throw new TelemetryDataModelException("No data for the period " + timePeriod.toString());<a name="line.95"></a>
<FONT color="green">096</FONT>        }<a name="line.96"></a>
<FONT color="green">097</FONT>        return dataPoint.getValue();<a name="line.97"></a>
<FONT color="green">098</FONT>      }<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>      /**<a name="line.100"></a>
<FONT color="green">101</FONT>       * Gets a list of data points in this telemetry stream, ordered by time<a name="line.101"></a>
<FONT color="green">102</FONT>       * period.<a name="line.102"></a>
<FONT color="green">103</FONT>       * <a name="line.103"></a>
<FONT color="green">104</FONT>       * @return A collection of &lt;code&gt;TelemetryDataPoint&lt;/code&gt; objects.<a name="line.104"></a>
<FONT color="green">105</FONT>       */<a name="line.105"></a>
<FONT color="green">106</FONT>      public List&lt;TelemetryDataPoint&gt; getDataPoints() {<a name="line.106"></a>
<FONT color="green">107</FONT>        ArrayList&lt;TelemetryDataPoint&gt; list = <a name="line.107"></a>
<FONT color="green">108</FONT>          new ArrayList&lt;TelemetryDataPoint&gt;(this.dataPoints.values());<a name="line.108"></a>
<FONT color="green">109</FONT>        Collections.sort(list, DATAPOINT_TIMEPERIOD_COMPARATOR);<a name="line.109"></a>
<FONT color="green">110</FONT>        return list;<a name="line.110"></a>
<FONT color="green">111</FONT>      }<a name="line.111"></a>
<FONT color="green">112</FONT>    <a name="line.112"></a>
<FONT color="green">113</FONT>      /**<a name="line.113"></a>
<FONT color="green">114</FONT>       * Comparator for &lt;code&gt;TelemetryDataPoint&lt;/code&gt; instances based on their<a name="line.114"></a>
<FONT color="green">115</FONT>       * time period property.<a name="line.115"></a>
<FONT color="green">116</FONT>       * <a name="line.116"></a>
<FONT color="green">117</FONT>       * @author (Cedric) Qin Zhang<a name="line.117"></a>
<FONT color="green">118</FONT>       */<a name="line.118"></a>
<FONT color="green">119</FONT>      private static class TelemetryDataPointTimePeriodComparator <a name="line.119"></a>
<FONT color="green">120</FONT>      implements Serializable, Comparator&lt;TelemetryDataPoint&gt; {<a name="line.120"></a>
<FONT color="green">121</FONT>    <a name="line.121"></a>
<FONT color="green">122</FONT>        private static final long serialVersionUID = 1L;<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>        /**<a name="line.124"></a>
<FONT color="green">125</FONT>         * Compares two instances.<a name="line.125"></a>
<FONT color="green">126</FONT>         * <a name="line.126"></a>
<FONT color="green">127</FONT>         * @param o1 Data point 1.<a name="line.127"></a>
<FONT color="green">128</FONT>         * @param o2 Data point 2.<a name="line.128"></a>
<FONT color="green">129</FONT>         * <a name="line.129"></a>
<FONT color="green">130</FONT>         * @return 0 indicates they are equal, positive value indicates data point 1<a name="line.130"></a>
<FONT color="green">131</FONT>         *         has later time stamp than data point 2, negative value indicates<a name="line.131"></a>
<FONT color="green">132</FONT>         *         data point 1 has earlier time stamp than data point 2.<a name="line.132"></a>
<FONT color="green">133</FONT>         */<a name="line.133"></a>
<FONT color="green">134</FONT>        public int compare(TelemetryDataPoint o1, TelemetryDataPoint o2) {<a name="line.134"></a>
<FONT color="green">135</FONT>          TimePeriod t1 = o1.getPeriod();<a name="line.135"></a>
<FONT color="green">136</FONT>          TimePeriod t2 = o2.getPeriod();<a name="line.136"></a>
<FONT color="green">137</FONT>          return t1.compareTo(t2);<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>      }<a name="line.139"></a>
<FONT color="green">140</FONT>    }<a name="line.140"></a>




























































</PRE>
</BODY>
</HTML>
